home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / pmcd.z / pmcd
Encoding:
Text File  |  2002-10-03  |  43.6 KB  |  793 lines

  1.  
  2.  
  3.  
  4. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmccccdddd - performance metrics collector daemon
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ppppmmmmccccdddd [----ffff] [----iiii _i_p_a_d_d_r_e_s_s] [----llll _l_o_g_f_i_l_e] [----LLLL _b_y_t_e_s] [----nnnn _p_m_n_s_f_i_l_e] [----qqqq
  13.      _t_i_m_e_o_u_t] [----TTTT _t_r_a_c_e_f_l_a_g] [----tttt _t_i_m_e_o_u_t] [----xxxx _f_i_l_e]
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      ppppmmmmccccdddd is the collector used by the Performance Co-Pilot (see PPPPCCCCPPPPIIIInnnnttttrrrroooo(1))
  17.      to gather performance metrics on a system.  As a rule, there must be an
  18.      instance of ppppmmmmccccdddd running on a system for any performance metrics to be
  19.      available to the PCP.
  20.  
  21.      ppppmmmmccccdddd accepts connections from client applications running either on the
  22.      same machine or remotely and provides them with metrics and other related
  23.      information from the machine that ppppmmmmccccdddd is executing on.  ppppmmmmccccdddd delegates
  24.      most of this request servicing to a collection of Performance Metrics
  25.      Domain Agents (or just agents), where each agent is responsible for a
  26.      particular group of metrics, known as the domain of the agent.  For
  27.      example the eeeennnnvvvviiiirrrroooonnnn agent is responsible for reporting information
  28.      relating to the environment of a Challenge system, such as the cabinet
  29.      temperature and voltage levels of the power supply.
  30.  
  31.      The agents may be processes started by ppppmmmmccccdddd, independent processes or
  32.      Dynamic Shared Objects (DSOs, see ddddssssoooo(5)) attached to ppppmmmmccccdddd's address
  33.      space.  The configuration section below describes how connections to
  34.      agents are specified.
  35.  
  36.      The options to ppppmmmmccccdddd are as follows.
  37.  
  38.      ----ffff   By default ppppmmmmccccdddd is started as a daemon.  The ----ffff option indicates
  39.           that it should run in the foreground.  This is most useful when
  40.           trying to diagnose problems with misbehaving agents.
  41.  
  42.      ----iiii _i_p_a_d_d_r_e_s_s
  43.           This option is usually only used on hosts with more than one network
  44.           interface.  If no ----iiii options are specified ppppmmmmccccdddd accepts connections
  45.           made to any of its host's IP (Internet Protocol) addresses.  The ----iiii
  46.           option is used to specify explicitly an IP address that connections
  47.           should be accepted on.  _i_p_a_d_d_r_e_s_s should be in the standard dotted
  48.           form (e.g. 100.23.45.6).  The ----iiii option may be used multiple times
  49.           to define a list of IP addresses.  Connections made to any other IP
  50.           addresses the host has will be refused.  This can be used to limit
  51.           connections to one network interface if the host is a network
  52.           gateway.  It is also useful if the host takes over the IP address of
  53.           another host that has failed.  In such a situation only the standard
  54.           IP addresses of the host should be given (not the ones inherited
  55.           from the failed host).  This allows PCP applications to determine
  56.           that a host has failed, rather than connecting to the host that has
  57.           assumed the identity of the failed host.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  71.  
  72.  
  73.  
  74.      ----llll _l_o_g_f_i_l_e
  75.           By default a log file named _p_m_c_d._l_o_g is written in the directory
  76.           $$$$PPPPCCCCPPPP____LLLLOOOOGGGG____DDDDIIIIRRRR////ppppmmmmccccdddd.  The ----llll option causes the log file to be written
  77.           to _l_o_g_f_i_l_e instead of the default.  If the log file cannot be
  78.           created or is not writable, output is written to the standard error
  79.           instead.
  80.  
  81.      ----LLLL _b_y_t_e_s
  82.           _P_D_Us received by ppppmmmmccccdddd from monitoring clients are restricted to a
  83.           maximum size of 65536 bytes by default to defend against Denial of
  84.           Service attacks.  The ----LLLL option may be used to change the maximum
  85.           incoming _P_D_U size.
  86.  
  87.      ----nnnn _p_m_n_s_f_i_l_e
  88.           Normally ppppmmmmccccdddd loads the default Performance Metrics Name Space
  89.           (PMNS) from $$$$PPPPCCCCPPPP____VVVVAAAARRRR____DDDDIIIIRRRR////ppppmmmmnnnnssss////rrrrooooooootttt, however if the ----nnnn option is
  90.           specified an alternative namespace is loaded from the file _p_m_n_s_f_i_l_e.
  91.  
  92.      ----qqqq _t_i_m_e_o_u_t
  93.           The pmcd to agent version exchange protocol (new in PCP 2.0 -
  94.           introduced to provide backward compatibility) uses this timeout to
  95.           specify how long pmcd should wait before assuming that no version
  96.           response is coming from an agent.  If this timeout is reached, the
  97.           agent is assumed to be an agent which does not understand the PCP
  98.           2.0 protocol.  The default timeout interval is five seconds, but the
  99.           ----qqqq option allows an alternative timeout interval (which must be
  100.           greater than zero) to be specified.  The unit of time is seconds.
  101.  
  102.      ----tttt _t_i_m_e_o_u_t
  103.           To prevent misbehaving agents from hanging the entire Performance
  104.           Metrics Collection System (PMCS), ppppmmmmccccdddd uses timeouts on PDU
  105.           exchanges with agents running as processes.  By default the timeout
  106.           interval is five seconds.  The ----tttt option allows an alternative
  107.           timeout interval in seconds to be specified.  If _t_i_m_e_o_u_t is zero,
  108.           timeouts are turned off.  It is almost impossible to use the
  109.           debugger interactively on an agent unless timeouts have been turned
  110.           off for its "parent" ppppmmmmccccdddd.
  111.  
  112.           Once ppppmmmmccccdddd is running, the timeout may be dynamically modified by
  113.           storing an integer value (the timeout in seconds) into the metric
  114.           ppppmmmmccccdddd....ccccoooonnnnttttrrrroooollll....ttttiiiimmmmeeeeoooouuuutttt via ppppmmmmssssttttoooorrrreeee(1).
  115.  
  116.      ----TTTT _t_r_a_c_e_f_l_a_g
  117.           To assist with error diagnosis for agents and/or clients of ppppmmmmccccdddd
  118.           that are not behaving correctly, an internal event tracing mechanism
  119.           is supported within ppppmmmmccccdddd.  The value of _t_r_a_c_e_f_l_a_g is interpreted as
  120.           a bit field with the following control functions:
  121.  
  122.           1111   enable client connection tracing
  123.           2222   enable PDU tracing
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  137.  
  138.  
  139.  
  140.           222255556666 unbuffered event tracing
  141.  
  142.           By default, event tracing is buffered using a circular buffer that
  143.           is over-written as new events are recorded.  The default buffer size
  144.           holds the last 20 events, although this number may be over-ridden by
  145.           using ppppmmmmssssttttoooorrrreeee(1) to modify the metric ppppmmmmccccdddd....ccccoooonnnnttttrrrroooollll....ttttrrrraaaacccceeeebbbbuuuuffffssss.
  146.  
  147.           Similarly once ppppmmmmccccdddd is running, the event tracing control may be
  148.           dynamically modified by storing 1 (enable) or 0 (disable) into the
  149.           metrics ppppmmmmccccdddd....ccccoooonnnnttttrrrroooollll....ttttrrrraaaacccceeeeccccoooonnnnnnnn, ppppmmmmccccdddd....ccccoooonnnnttttrrrroooollll....ttttrrrraaaacccceeeeppppdddduuuu and
  150.           ppppmmmmccccdddd....ccccoooonnnnttttrrrroooollll....ttttrrrraaaacccceeeennnnoooobbbbuuuuffff.  These metrics map to the bit fields
  151.           associated with the _t_r_a_c_e_f_l_a_g argument for the ----TTTT option.
  152.  
  153.           When operating in buffered mode, the event trace buffer will be
  154.           dumped whenever an agent connection is terminated by ppppmmmmccccdddd, or when
  155.           any value is stored into the metric ppppmmmmccccdddd....ccccoooonnnnttttrrrroooollll....dddduuuummmmppppttttrrrraaaacccceeee via
  156.           ppppmmmmssssttttoooorrrreeee(1).
  157.  
  158.           In unbuffered mode, eeeevvvveeeerrrryyyy event will be reported when it occurs.
  159.  
  160.      ----xxxx _f_i_l_e
  161.           Before the ppppmmmmccccdddd _l_o_g_f_i_l_e can be opened, ppppmmmmccccdddd may encounter a fatal
  162.           error which prevents it from starting.  By default, the output
  163.           describing this error is sent to ////ddddeeeevvvv////ttttttttyyyy but it may redirected to
  164.           _f_i_l_e.
  165.  
  166.      If a PDU exchange with an agent times out, the agent has violated the
  167.      requirement that it delivers metrics with little or no delay.  This is
  168.      deemed a protocol failure and the agent is disconnected from ppppmmmmccccdddd.  Any
  169.      subsequent requests for information from the agent will fail with a
  170.      status indicating that there is no agent to provide it.
  171.  
  172.      It is possible to specify host-level access control to ppppmmmmccccdddd.  This allows
  173.      one to prevent users from certain hosts from accessing the metrics
  174.      provided by ppppmmmmccccdddd and is described in more detail in the Section on ACCESS
  175.      CONTROL below.
  176.  
  177. CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
  178.      On startup ppppmmmmccccdddd looks for a configuration file named $_P_C_P__P_M_C_D_C_O_N_F__P_A_T_H.
  179.      This file specifies which agents cover which performance metrics domains
  180.      and how ppppmmmmccccdddd should make contact with the agents.  An optional section
  181.      specifying host-based access controls may follow the agent configuration
  182.      data.
  183.  
  184.      WWWWaaaarrrrnnnniiiinnnngggg:  ppppmmmmccccdddd is usually started as part of the boot sequence and runs
  185.      as root.  The configuration file may contain shell commands to create
  186.      agents, which will be executed by root.  To prevent security breaches the
  187.      configuration file should be writable only by root.  The use of absolute
  188.      path names is also recommended.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  203.  
  204.  
  205.  
  206.      The case of the reserved words in the configuration file is unimportant,
  207.      but elsewhere, the case is preserved.
  208.  
  209.      Blank lines and comments are permitted (even encouraged) in the
  210.      configuration file.  A comment begins with a ``#'' character and finishes
  211.      at the end of the line.  A line may be continued by ensuring that the
  212.      last character on the line is a ``\'' (backslash).  A comment on a
  213.      continued line ends at the end of the continued line.  Spaces may be
  214.      included in lexical elements by enclosing the entire element in double
  215.      quotes (there must be whitespace before the opening and after the closing
  216.      quote).  A double quote preceded by a backslash is always a literal
  217.      double quote.  A ``#'' in double quotes or preceded by a backslash is
  218.      treated literally rather than as a comment delimiter.  Lexical elements
  219.      and separators are described further in the following sections.
  220.  
  221. AAAAGGGGEEEENNNNTTTT CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
  222.      Each line of the agent configuration section of the configuration file
  223.      contains details of how to connect ppppmmmmccccdddd to one of its agents and
  224.      specifies which metrics domain the agent deals with.  An agent may be
  225.      attached as a DSO, or via a socket, or a pair of pipes.
  226.  
  227.      Each line of the agent configuration section of the configuration file
  228.      must be either an agent specification, a comment, or a blank line.
  229.      Lexical elements are separated by whitespace characters, however a single
  230.      agent specification may not be broken across lines unless a \\\\ (backslash)
  231.      is used to continue the line.
  232.  
  233.      Each agent specification must start with a textual label (string)
  234.      followed by an integer in the range 1 to 254.  The label is a tag used to
  235.      refer to the agent and the integer specifies the domain for which the
  236.      agent supplies data.  This domain identifier corresponds to the domain
  237.      portion of the PMIDs handled by the agent.  Each agent must have a unique
  238.      label and domain identifier.
  239.  
  240.      For DSO agents a line of the form:
  241.  
  242.           _l_a_b_e_l _d_o_m_a_i_n-_n_o ddddssssoooo _e_n_t_r_y-_p_o_i_n_t _p_a_t_h
  243.  
  244.      should appear.  Where,
  245.  
  246.      _l_a_b_e_l         is a string identifying the agent
  247.      _d_o_m_a_i_n-_n_o     is an unsigned integer specifying the agent's domain in the
  248.                    range 1 to 254
  249.      _e_n_t_r_y-_p_o_i_n_t   is the name of an initialization function which will be
  250.                    called when the DSO is loaded
  251.      _p_a_t_h          designates the location of the DSO. This field is treated
  252.                    differently on Irix and on Linux. Later expects it to be an
  253.                    absolute pathname, while former uses some heuristics to
  254.                    find an agent. If _p_a_t_h begins with a //// it is taken as an
  255.                    absolute path specifying the DSO. If _p_a_t_h is relative, ppppmmmmccccdddd
  256.                    will expect to find the agent in a file with the name
  257.                    mmmmiiiippppssss_____s_i_m_a_b_i...._p_a_t_h, where _s_i_m_a_b_i is either oooo33332222, nnnn33332222 or 66664444.
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  269.  
  270.  
  271.  
  272.                    ppppmmmmccccdddd is only able to load DSO agents that have the same
  273.                    _s_i_m_a_b_i (Subprogram Interface Model ABI, or calling
  274.                    conventions) as it does (i.e. only one of the _s_i_m_a_b_i
  275.                    versions will be applicable).  The _s_i_m_a_b_i version of a
  276.                    running ppppmmmmccccdddd may be determined by fetching ppppmmmmccccdddd....ssssiiiimmmmaaaabbbbiiii.
  277.                    Alternatively, the ffffiiiilllleeee(1) command may be used to determine
  278.                    the _s_i_m_a_b_i version from the ppppmmmmccccdddd executable.
  279.  
  280.                    For a relative _p_a_t_h the environment variable PPPPMMMMCCCCDDDD____PPPPAAAATTTTHHHH
  281.                    defines a colon (:) separated list of directories to search
  282.                    when trying to locate the agent DSO.  The default search
  283.                    path is ////vvvvaaaarrrr////ppppccccpppp////lllliiiibbbb::::////uuuussssrrrr////ppppccccpppp////lllliiiibbbb.
  284.  
  285.      For agents providing socket connections, a line of the form
  286.  
  287.           _l_a_b_e_l _d_o_m_a_i_n-_n_o ssssoooocccckkkkeeeetttt _a_d_d_r-_f_a_m_i_l_y _a_d_d_r_e_s_s [ _c_o_m_m_a_n_d ]
  288.  
  289.      should appear.  Where,
  290.  
  291.      _l_a_b_e_l         is a string identifying the agent
  292.      _d_o_m_a_i_n-_n_o     is an unsigned integer specifying the agent's domain in the
  293.                    range 1 to 254
  294.      _a_d_d_r-_f_a_m_i_l_y   designates whether the socket is in the AAAAFFFF____IIIINNNNEEEETTTT or AAAAFFFF____UUUUNNNNIIIIXXXX
  295.                    domain, and the corresponding values for this parameter are
  296.                    iiiinnnneeeetttt and uuuunnnniiiixxxx respectively.
  297.      _a_d_d_r_e_s_s       specifies the address of the socket within the previously
  298.                    specified _a_d_d_r-_f_a_m_i_l_y. For uuuunnnniiiixxxx sockets, the address should
  299.                    be the name of an agent's socket on the local host (a valid
  300.                    address for the UNIX domain).  For iiiinnnneeeetttt sockets, the
  301.                    address may be either a port number or a port name which
  302.                    may be used to connect to an agent on the local host.
  303.                    There is no syntax for specifying an agent on a remote host
  304.                    as a ppppmmmmccccdddd deals only with agents on the same machine.
  305.      _c_o_m_m_a_n_d       is an optional parameter used to specify a command line to
  306.                    start the agent when ppppmmmmccccdddd initializes.  If _c_o_m_m_a_n_d is not
  307.                    present, ppppmmmmccccdddd assumes that the specified agent has already
  308.                    been created.  The _c_o_m_m_a_n_d is considered to start from the
  309.                    first non-white character after the socket address and
  310.                    finish at the next newline that isn't preceded by a
  311.                    backslash.  After a ffffoooorrrrkkkk(2) the _c_o_m_m_a_n_d is passed
  312.                    unmodified to eeeexxxxeeeeccccvvvveeee(2) to instantiate the agent.
  313.  
  314.      For agents interacting with the ppppmmmmccccdddd via stdin/stdout, a line of the
  315.      form:
  316.  
  317.           _l_a_b_e_l _d_o_m_a_i_n-_n_o ppppiiiippppeeee _p_r_o_t_o_c_o_l _c_o_m_m_a_n_d
  318.  
  319.      should appear.  Where,
  320.  
  321.      _l_a_b_e_l         is a string identifying the agent
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  335.  
  336.  
  337.  
  338.      _d_o_m_a_i_n-_n_o     is a unsigned integer specifying the agent's domain
  339.      _p_r_o_t_o_c_o_l      specifies whether a text-based (ASCII) or a binary protocol
  340.                    should be used over the pipes.  The two valid values for
  341.                    this parameter are tttteeeexxxxtttt and bbbbiiiinnnnaaaarrrryyyy.
  342.  
  343.                    NNNNooootttteeee:  To the best of our knowledge, nothing but the
  344.                    demonstration PMDA news agent and the America's Cup San
  345.                    Diego water temperature agent has ever used the ASCII PDU
  346.                    interface to ppppmmmmccccdddd.  The current PCP libraries (in
  347.                    particular _l_i_b_p_c_p__p_m_d_a and _l_i_b_p_c_p__t_r_a_c_e) make building a
  348.                    real PMDA less effort than fighting with the ASCII PDUs in
  349.                    a sssshhhh(1) script.  Consequently, support for ASCII PDUs and
  350.                    hence the keyword tttteeeexxxxtttt in the ppppmmmmccccdddd configuration file is
  351.                    discouraged.
  352.  
  353.      _c_o_m_m_a_n_d       specifies a command line to start the agent when ppppmmmmccccdddd
  354.                    initializes.  Note that _c_o_m_m_a_n_d is mandatory for pipe-based
  355.                    agents.  The _c_o_m_m_a_n_d is considered to start from the first
  356.                    non-white character after the _p_r_o_t_o_c_o_l parameter and finish
  357.                    at the next newline that isn't preceded by a backslash.
  358.                    After a ffffoooorrrrkkkk(2) the _c_o_m_m_a_n_d is passed unmodified to
  359.                    eeeexxxxeeeeccccvvvveeee(2) to instantiate the agent.
  360.  
  361. AAAACCCCCCCCEEEESSSSSSSS CCCCOOOONNNNTTTTRRRROOOOLLLL CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
  362.      The access control section of the configuration file is optional, but if
  363.      present it must follow the agent configuration data.  The case of
  364.      reserved words is ignored, but elsewhere case is preserved.  Lexical
  365.      elements in the access control section are separated by whitespace or the
  366.      special delimiter characters:  square brackets (``['' and ``]''), braces
  367.      (``{'' and ``}''), colon (``:''), semicolon (``;'') and comma (``,'').
  368.      The special characters are not treated as special in the agent
  369.      configuration section.
  370.  
  371.      The access control section of the file must start with a line of the
  372.      form:
  373.  
  374.      [[[[aaaacccccccceeeessssssss]]]]
  375.  
  376.      Leading and trailing whitespace may appear around and within the brackets
  377.      and the case of the aaaacccccccceeeessssssss keyword is ignored.  No other text may appear
  378.      on the line except a trailing comment.
  379.  
  380.      Following this line, the remainder of the configuration file should
  381.      contain lines that allow or disallow operations from particular hosts or
  382.      groups of hosts.
  383.  
  384.      There are two kinds of operations that occur via ppppmmmmccccdddd:
  385.  
  386.      ffffeeeettttcccchhhh          allows retrieval of information from ppppmmmmccccdddd.  This may be
  387.                     information about a metric (e.g. it's description,
  388.                     instance domain or help text) or a value for a metric.
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  401.  
  402.  
  403.  
  404.      ssssttttoooorrrreeee          allows ppppmmmmccccdddd to be used to store metric values in agents
  405.                     that permit store operations.
  406.  
  407.      Access to ppppmmmmccccdddd is granted at the host level, i.e. all users on a host are
  408.      granted the same level of access.  Permission to perform the ssssttttoooorrrreeee
  409.      operation should not be given indiscriminately; it has the potential to
  410.      be abused by malicious users.
  411.  
  412.      Hosts may be identified by name, IP address or a wildcarded IP address
  413.      with the single wildcard character ``*'' as the last-given component of
  414.      the IP address.  Host names may not be wildcarded.  The following are all
  415.      valid host identifiers:
  416.  
  417.           boing
  418.           localhost
  419.           giggle.melbourne.sgi.com
  420.           129.127.112.2
  421.           129.127.114.*
  422.           129.*
  423.           *
  424.  
  425.      The following are not valid host identifiers:
  426.  
  427.           *.melbourne
  428.           129.127.*.*
  429.           129.*.114.9
  430.           129.127*
  431.  
  432.      The first example is not allowed because only (numeric) IP addresses may
  433.      contain a wildcard.  The second example is not valid because there is
  434.      more than one wildcard character.  The third contains an embedded
  435.      wildcard, the fourth has a wildcard character that is not the last
  436.      component of the IP address (the last component is 127*).
  437.  
  438.      The name llllooooccccaaaallllhhhhoooosssstttt is given special treatment to make the behavior of
  439.      host wildcarding consistent.  Rather than being 127.0.0.1, it is mapped
  440.      to the primary IP address associated with the name of the host on which
  441.      ppppmmmmccccdddd is running.  Beware of this when running ppppmmmmccccdddd on multi-homed hosts.
  442.  
  443.      Access for hosts are allowed or disallowed by specifying statements of
  444.      the form:
  445.  
  446.           aaaalllllllloooowwww _h_o_s_t_l_i_s_t :::: _o_p_e_r_a_t_i_o_n_s ;;;;
  447.           ddddiiiissssaaaalllllllloooowwww _h_o_s_t_l_i_s_t :::: _o_p_e_r_a_t_i_o_n_s ;;;;
  448.  
  449.      _h_o_s_t_l_i_s_t      is a comma separated list of host identifiers.
  450.  
  451.      _o_p_e_r_a_t_i_o_n_s    is a comma separated list of the operation types described
  452.                    above, aaaallllllll (which allows/disallows all operations), or aaaallllllll
  453.                    eeeexxxxcccceeeepppptttt _o_p_e_r_a_t_i_o_n_s (which allows/disallows all operations
  454.                    except those listed).
  455.  
  456.  
  457.  
  458.  
  459.                                                                         PPPPaaaaggggeeee 7777
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  467.  
  468.  
  469.  
  470.      Where no specific aaaalllllllloooowwww or ddddiiiissssaaaalllllllloooowwww statement applies to an operation for
  471.      some host, the default is to allow the operation from that host.  In the
  472.      trivial case when there is no access control section in the configuration
  473.      file, all operations from all hosts are permitted.
  474.  
  475.      If a new connection to ppppmmmmccccdddd is attempted from a host that is not
  476.      permitted to perform any operations, the connection will be closed
  477.      immediately after an error response PPPPMMMM____EEEERRRRRRRR____PPPPEEEERRRRMMMMIIIISSSSSSSSIIIIOOOONNNN has been sent to
  478.      the client attempting the connection.
  479.  
  480.      Statements with the same level of wildcarding specifying identical hosts
  481.      may not contradict each other.  For example if a host named ccccllllaaaannnnkkkk had an
  482.      IP address of 129.127.112.2, specifying the following two rules would be
  483.      erroneous:
  484.  
  485.           allow clank : fetch, store;
  486.           disallow 129.127.112.2 : all except fetch;
  487.  
  488.      because they both refer to the same host, but disagree as to whether the
  489.      ffffeeeettttcccchhhh operation is permitted from that host.
  490.  
  491.      Statements containing more specific host specifications override less
  492.      specific ones according to the level of wildcarding.  For example a rule
  493.      of the form
  494.  
  495.           allow clank : all;
  496.  
  497.      overrides
  498.  
  499.           disallow 129.127.112.* : all except fetch;
  500.  
  501.      because the former contains a specific host name (equivalent to a fully
  502.      specified IP address), whereas the latter has a wildcard.  In turn, the
  503.      latter would override
  504.  
  505.           disallow * : all;
  506.  
  507.      It is possible to limit the number of connections from a host to ppppmmmmccccdddd.
  508.      This may be done by adding a clause of the form
  509.  
  510.           mmmmaaaaxxxxiiiimmmmuuuummmm _n ccccoooonnnnnnnneeeeccccttttiiiioooonnnnssss
  511.  
  512.      to the _o_p_e_r_a_t_i_o_n_s list of an aaaalllllllloooowwww statement.  Such a clause may not be
  513.      used in a ddddiiiissssaaaalllllllloooowwww statement.  Here, _n is the maximum number of
  514.      connections that will be accepted from hosts matching the host
  515.      identifier(s) used in the statement.
  516.  
  517.      An access control statement with a list of host identifiers is equivalent
  518.      to a group of access control statements, with each specifying one of the
  519.      host identifiers in the list and all with the same access controls (both
  520.      permissions and connection limits).  A wildcard should be used if you
  521.      want hosts to contribute to a shared connection limit.
  522.  
  523.  
  524.  
  525.                                                                         PPPPaaaaggggeeee 8888
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  533.  
  534.  
  535.  
  536.      When a new client requests a connection, and ppppmmmmccccdddd has determined that the
  537.      client has permission to connect, it searches the matching list of access
  538.      control statements for the most specific match containing a connection
  539.      limit.  For brevity, this will be called the limiting statement.  If
  540.      there is no limiting statement, the client is granted a connection.  If
  541.      there is a limiting statement and the number of ppppmmmmccccdddd clients with IP
  542.      addresses that match the host identifier in the limiting statement is
  543.      less than the connection limit in the statement, the connection is
  544.      allowed.  Otherwise the connection limit has been reached and the client
  545.      is refused a connection.
  546.  
  547.      The wildcarding in host identifiers means that once ppppmmmmccccdddd actually accepts
  548.      a connection from a client, the connection may contribute to the current
  549.      connection count of more than one access control statement (the client's
  550.      host may match more than one access control statement).  This may be
  551.      significant for subsequent connection requests.
  552.  
  553.      Note that because most specific match semantics are used when checking
  554.      the connection limit, priority is given to clients with more specific
  555.      host identifiers.  It is also possible to exceed connection limits in
  556.      some situations.  Consider the following:
  557.  
  558.           allow clank : all, maximum 5 connections;
  559.           allow * : all except store, maximum 2 connections;
  560.  
  561.      This says that only 2 client connections at a time are permitted for all
  562.      hosts other than "clank", which is permitted 5.  If a client from host
  563.      "boing" is the first to connect to ppppmmmmccccdddd, it's connection is checked
  564.      against the second statement (that is the most specific match with a
  565.      connection limit).  As there are no other clients, the connection is
  566.      accepted and contributes towards the limit for only the second statement
  567.      above.  If the next client connects from "clank", its connection is
  568.      checked against the limit for the first statement.  There are no other
  569.      connections from "clank", so the connection is accepted.  Once this
  570.      connection is accepted, it counts towards bbbbooootttthhhh statements' limits because
  571.      "clank" matches the host identifier in both statements.  Remember that
  572.      the decision to accept a new connection is made using only the most
  573.      specific matching access control statement with a connection limit.  Now,
  574.      the connection limit for the second statement has been reached.  Any
  575.      connections from hosts other than "clank" will be refused.
  576.  
  577.      If instead, ppppmmmmccccdddd with no clients saw three successive connections arrived
  578.      from "boing", the first two would be accepted and the third refused.
  579.      After that, if a connection was requested from "clank" it would be
  580.      accepted.  It matches the first statement, which is more specific than
  581.      the second, so the connection limit in the first is used to determine
  582.      that the client has the right to connect.  Now there are 3 connections
  583.      contributing to the second statement's connection limit.  Even though the
  584.      connection limit for the second statement has been exceeded, the earlier
  585.      connections from "boing" are maintained.  The connection limit is only
  586.      checked at the time a client attempts a connection rather than being re-
  587.      evaluated every time a new client connects to ppppmmmmccccdddd.
  588.  
  589.  
  590.  
  591.                                                                         PPPPaaaaggggeeee 9999
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  599.  
  600.  
  601.  
  602.      This gentle scheme is designed to allow reasonable limits to be imposed
  603.      on a first come first served basis, with specific exceptions.
  604.  
  605.      As illustrated by the example above, a client's connection is honored
  606.      once it has been accepted.  However, ppppmmmmccccdddd reconfiguration (see the next
  607.      section) re-evaluates all the connection counts and will cause client
  608.      connections to be dropped where connection limits have been exceeded.
  609.  
  610. RRRREEEECCCCOOOONNNNFFFFIIIIGGGGUUUURRRRIIIINNNNGGGG PPPPMMMMCCCCDDDD
  611.      If the configuration file has been changed or if an agent is not
  612.      responding because it has terminated or the PMNS has been changed, ppppmmmmccccdddd
  613.      may be reconfigured by sending it a SIGHUP, as in
  614.  
  615.           # killall -HUP pmcd
  616.  
  617.      When ppppmmmmccccdddd receives a SIGHUP, it checks the configuration file for
  618.      changes.  If the file has been modified, it is reparsed and the contents
  619.      become the new configuration.  If there are errors in the configuration
  620.      file, the existing configuration is retained and the contents of the file
  621.      are ignored.  Errors are reported in the ppppmmmmccccdddd log file.
  622.  
  623.      It also checks the PMNS file for changes. If the PMNS file has been
  624.      modified, then it is reloaded.  Use of ttttaaaaiiiillll(1) on the log file is
  625.      recommended while reconfiguring ppppmmmmccccdddd.
  626.  
  627.      If the configuration for an agent has changed (any parameter except the
  628.      agent's label is different), the agent is restarted.  Agents whose
  629.      configurations do not change are not restarted.  Any existing agents not
  630.      present in the new configuration are terminated.  Any deceased agents are
  631.      that are still listed are restarted.
  632.  
  633.      Sometimes it is necessary to restart an agent that is still running, but
  634.      malfunctioning.  Simply kill the agent, then send ppppmmmmccccdddd a SIGHUP, which
  635.      will cause the agent to be restarted.
  636.  
  637. SSSSTTTTAAAARRRRTTTTIIIINNNNGGGG AAAANNNNDDDD SSSSTTTTOOOOPPPPPPPPIIIINNNNGGGG PPPPMMMMCCCCDDDD
  638.      Normally, ppppmmmmccccdddd is started automatically at boot time and stopped when the
  639.      system is being brought down (see rrrrcccc2222(1M) and rrrrcccc0000(1M)).  Under certain
  640.      circumstances it is necessary to start or stop ppppmmmmccccdddd manually.  To do this
  641.      one must become superuser and type
  642.  
  643.           # $PCP_RC_DIR/pcp start
  644.  
  645.      to start ppppmmmmccccdddd, or
  646.  
  647.           # $PCP_RC_DIR/pcp stop
  648.  
  649.      to stop ppppmmmmccccdddd.  Starting ppppmmmmccccdddd when it is already running is the same as
  650.      stopping it and then starting it again.
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.                                                                        PPPPaaaaggggeeee 11110000
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  665.  
  666.  
  667.  
  668.      Sometimes it may be necessary to restart ppppmmmmccccdddd during another phase of the
  669.      boot process.  Time-consuming parts of the boot process are often put
  670.      into the background to allow the system to become available sooner (e.g.
  671.      mounting huge databases).  If an agent run by ppppmmmmccccdddd requires such a task
  672.      to complete before it can run properly, it is necessary to restart or
  673.      reconfigure ppppmmmmccccdddd after the task completes.  Consider, for example, the
  674.      case of mounting a database in the background while booting.  If the PMDA
  675.      which provides the metrics about the database cannot function until the
  676.      database is mounted and available but ppppmmmmccccdddd is started before the database
  677.      is ready, the PMDA will fail (however ppppmmmmccccdddd will still service requests
  678.      for metrics from other domains).  If the database is initialized by
  679.      running a shell script, adding a line to the end of the script to
  680.      reconfigure ppppmmmmccccdddd (by sending it a SIGHUP) will restart the PMDA (if it
  681.      exited because it couldn't connect to the database).  If the PMDA didn't
  682.      exit in such a situation it would be necessary to restart ppppmmmmccccdddd because if
  683.      the PMDA was still running ppppmmmmccccdddd would not restart it.
  684.  
  685.      Normally ppppmmmmccccdddd listens for client connections on TCP/IP port number 4321.
  686.      The environment variable PPPPMMMMCCCCDDDD____PPPPOOOORRRRTTTT may be used to specify an alternative
  687.      port number.  If PPPPMMMMCCCCDDDD____PPPPOOOORRRRTTTT is used, care should be taken to ensure the
  688.      environment variable is set before ppppmmmmccccdddd is started, and also in the
  689.      environment of any client application that will connect to ppppmmmmccccdddd.
  690.  
  691. LLLLIIIICCCCEEEENNNNSSSSEEEESSSS
  692.      In previous PCP releases, ppppmmmmccccdddd would terminate immediately if there was
  693.      no valid _C_o_l_l_e_c_t_o_r license on the localhost.  This has now changed so
  694.      that on Irix ppppmmmmccccdddd will run on hosts without a _C_o_l_l_e_c_t_o_r license, however
  695.      an unlicensed ppppmmmmccccdddd will only accept connections from authorized clients.
  696.      On Linux ppppmmmmccccdddd will run on any host without a license and will accept
  697.      connections from any client. Not all PCP tools are authorized clients.
  698.      See the PCP release notes for more details about licenses for PCP.
  699.  
  700. FFFFIIIILLLLEEEESSSS
  701.      $_P_C_P__P_M_C_D_C_O_N_F__P_A_T_H
  702.                default configuration file
  703.      $_P_C_P__P_M_C_D_O_P_T_I_O_N_S__P_A_T_H
  704.                command line options to ppppmmmmccccdddd when launched from $$$$PPPPCCCCPPPP____RRRRCCCC____DDDDIIIIRRRR////ppppccccpppp
  705.                All the command line option lines should start with a hyphen as
  706.                the first character.  This file can also contain environment
  707.                variable settings of the form "VARIABLE=value".
  708.      ....////ppppmmmmccccdddd....lllloooogggg
  709.                (or $$$$PPPPCCCCPPPP____LLLLOOOOGGGG____DDDDIIIIRRRR////ppppmmmmccccdddd////ppppmmmmccccdddd....lllloooogggg when started automatically)
  710.                All messages and diagnostics are directed here
  711.  
  712. EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  713.      In addition to the PCP environment variables described in the PPPPCCCCPPPP
  714.      EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT section below, the PPPPMMMMCCCCDDDD____PPPPOOOORRRRTTTT variable is also recognised as
  715.      the TCP/IP port for incoming connections (default _4_3_2_1).
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.                                                                        PPPPaaaaggggeeee 11111111
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730. PPPPMMMMCCCCDDDD((((1111))))                                                                PPPPMMMMCCCCDDDD((((1111))))
  731.  
  732.  
  733.  
  734. PCP ENVIRONMENT
  735.      Environment variables with the prefix PPPPCCCCPPPP____ are used to parameterize the
  736.      file and directory names used by PCP.  On each installation, the file
  737.      ////eeeettttcccc////ppppccccpppp....ccccoooonnnnffff contains the local values for these variables.  The
  738.      $$$$PPPPCCCCPPPP____CCCCOOOONNNNFFFF variable may be used to specify an alternative configuration
  739.      file, as described in ppppccccpppp....ccccoooonnnnffff(4).
  740.  
  741. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  742.      PPPPCCCCPPPPIIIInnnnttttrrrroooo(1), ppppmmmmddddbbbbgggg(1), ppppmmmmeeeerrrrrrrr(1), ppppmmmmggggeeeennnnmmmmaaaapppp(1), ppppmmmmiiiinnnnffffoooo(1), ppppmmmmkkkkssssttttaaaatttt(1),
  743.      ppppmmmmssssttttoooorrrreeee(1), ppppmmmmvvvvaaaallll(1), ppppccccpppp....ccccoooonnnnffff(4), ppppccccpppp....eeeennnnvvvv(4) and ddddssssoooo(5).
  744.  
  745. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  746.      If ppppmmmmccccdddd is already running the message "Error: OpenRequestSocket bind:
  747.      Address already in use" will appear.  This may also appear if ppppmmmmccccdddd was
  748.      shutdown with an outstanding request from a client.  In this case, a
  749.      request socket has been left in the TIME_WAIT state and until the system
  750.      closes it down (after some timeout period) it will not be possible to run
  751.      ppppmmmmccccdddd.
  752.  
  753.      In addition to the standard PPPPCCCCPPPP debugging flags, see ppppmmmmddddbbbbgggg(1), ppppmmmmccccdddd
  754.      currently uses DDDDBBBBGGGG____TTTTRRRRAAAACCCCEEEE____AAAAPPPPPPPPLLLL0000 for tracing I/O and termination of agents,
  755.      DDDDBBBBGGGG____TTTTRRRRAAAACCCCEEEE____AAAAPPPPPPPPLLLL1111 for tracing host access control (see below) and
  756.      DDDDBBBBGGGG____TTTTRRRRAAAACCCCEEEE____AAAAPPPPPPPPLLLL2222 for tracing the configuration file scanner and parser.
  757.  
  758. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  759.      ppppmmmmccccdddd does not kill its child agents, it only closes their pipes.  If an
  760.      agent never checks for a closed pipe it may not terminate.
  761.  
  762.      The configuration file parser will only read lines of less than 1200
  763.      characters.  This is intended to prevent accidents with binary files.
  764.  
  765.      The timeouts controlled by the ----tttt option apply to IPC between ppppmmmmccccdddd and
  766.      the PMDAs it spawns.  This is independent of settings of the environment
  767.      variables PPPPMMMMCCCCDDDD____CCCCOOOONNNNNNNNEEEECCCCTTTT____TTTTIIIIMMMMEEEEOOOOUUUUTTTT and PPPPMMMMCCCCDDDD____RRRREEEEQQQQUUUUEEEESSSSTTTT____TTTTIIIIMMMMEEEEOOOOUUUUTTTT (see PPPPCCCCPPPPIIIInnnnttttrrrroooo(1))
  768.      which may be used respectively to control timeouts for client
  769.      applications trying to connect to ppppmmmmccccdddd and trying to receive information
  770.      from ppppmmmmccccdddd.
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.                                                                        PPPPaaaaggggeeee 11112222
  790.  
  791.  
  792.  
  793.